Skip to main content

User Group to User Config Associations

  • optional

A Template Package can include associations that should exist between user groups and user configs. If these relations are found not to exist they will be created during deployment. These relations can be defined in the manifest.userGroupToUserConfig array by providing the name of the group and the name of the config.

// manifest.json"userGroupToUserConfig": [   { "group": "Sample User Group", "config": "Sample User Config" }]

Both the user group and the config mut exist in order for the relation to be created.

Complete Example:#

// manifest.json{   "Template Name": "Water Treatment Operations Digital Twin",   "Template Version": "1.0.5",   "configs": [      {         "_name": "Sample User Config",         "_shortName": "sampleuc",         "_description": "A sample user config",         "_userType": "sample"      }   ],   "userGroups": [      {         "_name": "Sample User Group",         "_shortName": "sample-group",         "_description": "A sample user group with full Admin permissions",         "permissions": {            "accessAll": true         }      }   ],   "userGroupToUserConfig": [      { "group": "Sample User Group", "config": "Sample User Config" }   ]}
// Package Zip FileWater Treatment Template.zip /||-- configs /|   |-- Sample User Config.json||-- manifest.json
// Sample User Config.json{  "handlers": {},  "homepage": {},  "groupedPages": {},  "settings": {}}

Deploying User Group to User Config Associations#

When the Template Package is deployed, either the user group or the user config does not exist, it will be skipped. If the association already exists between and existing user group and an existing user config it will be skipped.